Translating the RUP

This page describes what you have to do in order to translate the Rational Unified Process to other languages than English.

Topics

Translate the HTML pages

The following steps must be performed in order to translate the HTML pages.

Install the Rational Unified Process on a computer with the non-English operating system. We recommend that you do the translation on the operating system on which the translated RUP will be installed.
Set the default character set for all HTML pages in the RUP. This has to be done programmatically, by either using a global search-and-replace tool, or with by writing a script.
Translate all text in HTML pages.
Translate the title of all HTML pages.
Translate all bookmarks. You also need to update all hyperlinks that reference these bookmarks. Notice that bookmarks with the prefix 'XE_' are index entries. This is explained below, in section Generate an index.
Translate the text in all the diagrams and pictures.
Translate the text on the navigational buttons.

Translate the treebrowser

Perform the following steps to translate the treebrowser. See The Treebrowser for information about the tree.dat file.

Extract the 'tree.dat' file from the file 'applet/tree.zip'.
Translate the 'applet/tree.dat' file.
Replace the 'tree.dat' in the 'applet/tree.zip'.
The treebrowser applet is declared in the file 'applet/orytree.htm'. Change the values of the following parameters in the treebrowser applet declaration (at least):

'characterset'

'treefont'

'delimeter'

IMPORTANT: In the 'tree.dat' file there is one character that is used as delimiter (or separator), this is a 'ñ'. When you move the RUP to other language versions of the operating system, this character may be converted to some other character.

Open the tree.dat file to see what character is used as delimiter (or separator).
Change the declaration of the treebrowser applet in the file 'applet/orytree.htm'. Change the value of the parameter 'delimeter' to the character that is used as delimiter (or separator).

Example

The following is an example of the file 'applet/orytree.htm'. The example shows how you can change the declaration of the treebrowser applet. The new (or changed) lines are marked with red.

<!---

document.writeln("<applet name=\"Tree\" codebase=\"./\" code=\"ruptools.TreeBrowse.class\" width=\"100%\" archive=\"treebrowse.zip\" height=\"97%\">\n");

document.writeln("<param name=\"loadpage\" value=\"../spscreen.htm\">\n");

printFinishPage();

document.writeln("<param name=\"fgcolor\" value=\"51,102,153\">\n");

document.writeln("<param name=\"delimeters\" value=\"ñ\">\n");

document.writeln("<param name=\"characterset\" value=\"SJIS\">\n");

document.writeln("<param name=\"selbgcolor\" value=\"51,102,153\">\n");

document.writeln("<param name=\"selfgcolor\" value=\"white\">\n");

document.writeln("<param name=\"visitcolor\" value=\"51,51,51\">\n");

document.writeln("<param name=\"mouseovercolor\" value=\"0,0,102\">\n");

document.writeln("<param name=\"mouseovershadow\" value=\"false\">\n");

document.writeln("<param name=\"loadinglabel\" value=\"Loading contents tree...\">\n");

document.writeln("<param name=\"target\" value=\"ory_doc\">\n");

document.writeln("<param name=\"maxvisiblenodes\" value=\"100\">\n");

document.writeln("<param name=\"scrollbartoleft\" value=\"false\">\n");

document.writeln("<param name=\"border\" value=\"true\">\n");

document.writeln("<param name=\"treefont\" value=\"Arial,plain,12\">\n");

document.writeln("<param name=\"bgcolor\" value=\"#FFFFFF\">\n");

document.writeln("</applet>\n");

//---> </Script>

Translate the search applet

The search applet is declared in the file 'applet/search.htm'. Some of the parameters specify the text in the search applet window. Translate the value of these parameters. See The Search applet for details about the search applet.

Generate an index

You should generate a new index, for the new language. See the page KeyWordIndex for more information.

Translate existing bookmarks and add new bookmarks in the HTML pages. In order to generate an index, you must translate all bookmarks with a leading 'XE_. One effect of translating these bookmarks is that you need to update all hyperlinks that reference these bookmarks.
Translate the file 'devkit/rupuse/keywords.txt'. This file contains the cross-references in the index.
Translate the title of the index in the file 'keywordpreamble.txt'.
Translate the text in the file 'keywordpostamble.txt'. This file describes the end of the generated index.
Generate a new index. See Tool Mentor: Using the Rational Unified Tools, section "Generating an Index", for detailed instructions.

Generate sitemap pages

The following steps describe how to generate new sitemap pages.

Update the pages that specify the layout of the sitemap pages. See page Sitemap, section "Layout of the Sitemap", for details on how to specify the layout of the sitemap pages. The layout of the sitemap pages are specified in the following files in the folder 'devkit/rupuse/sitemap':
- artifactdef.txt
- overviewdef.txt
- sitemapdef.txt
- templatedef.txt
- toolmentorsdef.txt
- workerdef.txt
- workflowdef.txt
Translate the relevant parts of the following two files:
- sitepostamble.txt
- sitepreamble.txt
Generate a new index. See Tool Mentor: Using the Rational Unified Tools, section "Generating a Process Overview Table".

Generate a search database

Generate a new search database. See Tool Mentor: Using the Rational Unified Tools, section "Generating a Search Database" for detailed instructions.

Translate the RUP tools

The tools for generating a search database, generating the index, and generating the sitemap, all produce progress messages and error messages in English.

All these messages can be translated to any language. The message can be specified in a text file which is used by the tools. See Translating the RUP Tools, for details on how to create this file.

Rational Unified Process